org.eclipse.vtp.framework.interactions.core.configurations
Class SelectionRequestConfiguration

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.configurations.SelectionRequestConfiguration

All Implemented Interfaces:

IConfiguration, InteractionsConstants

public class SelectionRequestConfiguration
extends java.lang.Object
implements IConfiguration, InteractionsConstants

Configuration for a selection request interaction.

Author:

Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.interactions.core.configurations.InteractionsConstants

NAME_CHOICE, NAME_CHOICES, NAME_CONTENT_TYPE, NAME_DATA_NAME, NAME_DATA_REQUEST, NAME_FORMATTER, NAME_ID, NAME_INPUT, NAME_INPUT_ITEM, NAME_INPUT_NAME, NAME_INPUT_REQUEST, NAME_INTERACTION_TYPE, NAME_KEY, NAME_LANGUAGE, NAME_LOCALE, NAME_MEDIA, NAME_MEDIA_PROVIDER, NAME_MEDIA_PROVIDER_BINDING, NAME_META_DATA, NAME_META_DATA_ITEM, NAME_META_DATA_SET, NAME_NAME, NAME_OUTPUT, NAME_OUTPUT_ITEM, NAME_OUTPUT_MESSAGE, NAME_OUTPUT_NAME, NAME_PROPERTY, NAME_PROPERTY_ITEM, NAME_RESOURCE_MANAGER, NAME_SCRIPT, NAME_SCRIPTING_LANGUGAGE, NAME_SELECTION_REQUEST, NAME_SHARED_CONTENT, NAME_TRANSFER_MESSAGE, NAME_TYPE, NAME_VALUE, NAMESPACE_URI

Constructor Summary

SelectionRequestConfiguration(IContentFactory contentFactory, IInputGrammarFactory inputFactory)
Creates a new SelectionRequestConfiguration.

Method Summary

void	addChoice(SelectionChoiceConfiguration choice) Adds a choice to this interaction.
java.lang.String[]	getBrandedChoices(java.lang.String brandName) Returns the choice names registered for the specified brand.
SelectionChoiceConfiguration[]	getChoices() Returns the choices in this interaction.
java.lang.String	getDataName() Returns the name of the data collected by this request.
MediaConfiguration	getMediaConfiguration() Returns the media configuration for this message or null if no such configuration is registered.
java.lang.String	getOutputName() Returns the name of the output item to play.
void	load(org.w3c.dom.Element configurationElement) Loads the configuration information from the specified XML element.
void	removeChoice(SelectionChoiceConfiguration choice) Removes a choice from this interaction.
void	save(org.w3c.dom.Element configurationElement) Saves the configuration information into the supplied XML element.
void	setBrandedChoices(java.lang.String brandName, java.lang.String[] choiceNames) Sets the choice names registered for the specified brand.
void	setDataName(java.lang.String dataName) Sets the name of the data collected by this request.
void	setMediaConfiguration(MediaConfiguration mediaConfiguration) Sets the media configuration for this message.
void	setOutputName(java.lang.String outputName) Sets the name of the output item to play.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SelectionRequestConfiguration

public SelectionRequestConfiguration(IContentFactory contentFactory,
                                     IInputGrammarFactory inputFactory)

Creates a new SelectionRequestConfiguration.

Parameters:

contentFactory - The content factory to use.

inputFactory - The input factory to use.

Method Detail

getOutputName

public java.lang.String getOutputName()

Returns the name of the output item to play.

Returns:

The name of the output item to play.

setOutputName

public void setOutputName(java.lang.String outputName)

Sets the name of the output item to play.

Parameters:

outputName - The name of the output item to play.

getDataName

public java.lang.String getDataName()

Returns the name of the data collected by this request.

Returns:

The name of the data collected by this request.

setDataName

public void setDataName(java.lang.String dataName)

Sets the name of the data collected by this request.

Parameters:

dataName - The name of the data collected by this request.

getMediaConfiguration

public MediaConfiguration getMediaConfiguration()

Returns the media configuration for this message or null if no such configuration is registered.

Returns:

The media configuration for this message or null if no such configuration is registered.

setMediaConfiguration

public void setMediaConfiguration(MediaConfiguration mediaConfiguration)

Sets the media configuration for this message.

Parameters:

mediaConfiguration - The media configuration for this message or null to remove the configuration.

getChoices

public SelectionChoiceConfiguration[] getChoices()

Returns the choices in this interaction.

Returns:

The choices in this interaction.

addChoice

public void addChoice(SelectionChoiceConfiguration choice)

Adds a choice to this interaction.

Parameters:

choice - The choice to add.

removeChoice

public void removeChoice(SelectionChoiceConfiguration choice)

Removes a choice from this interaction.

Parameters:

choice - The choice to remove.

getBrandedChoices

public java.lang.String[] getBrandedChoices(java.lang.String brandName)

Returns the choice names registered for the specified brand.

Parameters:

brandName - The name of the brand to find the choice names for.

Returns:

The choice names registered for the specified brand.

setBrandedChoices

public void setBrandedChoices(java.lang.String brandName,
                              java.lang.String[] choiceNames)

Sets the choice names registered for the specified brand.

Parameters:

brandName - The name of the brand to set the choice names for.

choiceNames - The choice names to register for the specified brand.

load

public void load(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Loads the configuration information from the specified XML element.

Specified by:

load in interface IConfiguration

Parameters:

configurationElement - The element to load the configuration from.

save

public void save(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Saves the configuration information into the supplied XML element.

Specified by:

save in interface IConfiguration

Parameters:

configurationElement - The element to save the configuration to.